/**
 * 
 * Copyright (C) 2011 Cody Stoutenburg . All rights reserved.
 *
 *       This program is free software; you can redistribute it and/or
 *       modify it under the terms of the GNU Lesser General Public License
 *       as published by the Free Software Foundation; either version 2.1
 *       of the License, or (at your option) any later version.
 *
 *       This program is distributed in the hope that it will be useful,
 *       but WITHOUT ANY WARRANTY; without even the implied warranty of
 *       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *       GNU Lesser General Public License for more details.
 *
 *       You should have received a copy of the GNU Lesser General Public License
 *       along with this program; if not, write to the Free Software
 *       Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. 
 * 
 */
package ca.usherbrooke.model;

import org.newdawn.slick.geom.Rectangle;

import ca.usherbrooke.tools.IGUID;
import ca.usherbrooke.tools.position.Vector2D;

/**
 * @author Cody Stoutenburg
 * 
 */
public interface IBaseModel extends IGUID {
	/**
	 * Get the name is a property of the model that can be set, the name is note
	 * unique but refer to a category of model that are similar <br/>
	 * <br/>
	 * for example: <br/>
	 * the name is use in the ui to map a model to an image <br/>
	 * 
	 * @return the name of the model
	 */
	String getName();

	/**
	 * Get the upper left position of the model
	 * 
	 * @return the upper left position of the model
	 */
	Vector2D getPosition();

	/**
	 * Get the center position of the model
	 * 
	 * @return the center position of the model
	 */
	Vector2D getCenterPosition();

	/**
	 * Get the size of the model. <br/>
	 * the size contain:
	 * <ul>
	 * <li>the x position of the model</li>
	 * <li>the y position of the model</li>
	 * <li>the width of the model</li>
	 * <li>the height of the model</li>
	 * </ul>
	 * 
	 * @return the rectangle that represente the
	 */
	Rectangle getSize();

	/**
	 * Set the position of the upper left corner of the model
	 * 
	 * @param position
	 *            the new position of the upper left corner
	 */
	void setPosition(Vector2D position);
}
